Resolve spec-librarian export coverage drift in pkg READMEs - #51592
Merged
Conversation
7 tasks
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Audit documentation accuracy issues in specifications
Resolve spec-librarian export coverage drift in pkg READMEs
Aug 9, 2026
pelikhan
marked this pull request as ready for review
August 9, 2026 15:17
Contributor
There was a problem hiding this comment.
Pull request overview
Updates package READMEs to align documented export coverage with current Go APIs.
Changes:
- Adds missing exported symbols across four packages.
- Removes the phantom CLI pricing function.
- Updates appendix coverage totals.
Show a summary per file
| File | Description |
|---|---|
pkg/cli/README.md |
Corrects and expands CLI export coverage. |
pkg/workflow/README.md |
Documents workflow configuration and helper APIs. |
pkg/parser/README.md |
Adds missing parser exports. |
pkg/agentdrain/README.md |
Adds exported coordinator, detector, masker, and miner methods. |
Review details
Tip
Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 4/4 changed files
- Comments generated: 2
- Review effort level: Balanced
| | `sandbox.go` | `AiCreditsPricingConfig` | `type AiCreditsPricingConfig struct { Input float64 Output float64 CachedInput *float64 CacheWrite *float64 }` | AiCreditsPricingConfig defines per-token pricing inputs used for AI-credit accounting. | | ||
| | `tools_types.go` | `BoundedQueriesConfig` | `type BoundedQueriesConfig struct { PrivateRepos []*BoundedQueryPrivateRepo Runtime BoundedQueryRuntime Timeout *int MemoryLimit string Interpreter string MaxInvocations *int ParseError string }` | BoundedQueriesConfig defines user-facing bounded-query tool configuration. | | ||
| | `tools_types.go` | `BoundedQueryPrivateRepo` | `type BoundedQueryPrivateRepo struct { Repo string Sensitivity string }` | BoundedQueryPrivateRepo describes one private repository entry in bounded-query config. | | ||
| | `tools_types.go` | `BoundedQueryRuntime` | `type BoundedQueryRuntime string` | BoundedQueryRuntime enumerates supported bounded-query runtimes. | |
| | File | Symbol | Declaration | Description | | ||
| |------|--------|-------------|-------------| | ||
| | `engine_helpers.go` | `BuildEngineSecretValidationStep` | `func BuildEngineSecretValidationStep(workflowData *WorkflowData, config EngineSecretValidationConfig) GitHubActionStep` | BuildEngineSecretValidationStep builds the reusable secret-validation step for engine credentials. | | ||
| | `engine_registry.go` | `(*EngineRegistry).EnginesWithCapability` | `func (r *EngineRegistry) EnginesWithCapability(predicate func(EngineCapabilities) bool) []string` | EnginesWithCapability returns sorted engine IDs that satisfy a capability predicate. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The package spec audit reported a phantom API entry and missing exported-symbol coverage across
pkg/cli,pkg/workflow,pkg/parser, andpkg/agentdraindespite full README presence. This PR updates those specs so README export coverage matches current source exports.Spec accuracy corrections
FindOrFetchModelPricingentry frompkg/cli/README.md(symbol is not exported).Export coverage additions:
pkg/parserMCPRootInfoErrUnsupportedSyntax,ErrVerificationSkippedIsAnyGitHubHostEnvVarSet,IsGitHubHost,IsImportSafeSharedWorkflowOnExport coverage additions:
pkg/agentdrain(*Coordinator).AllClusters(*Coordinator).LoadWeightsJSON(*Coordinator).SaveSnapshots(*Coordinator).SaveWeightsJSON(*AnomalyDetector).Analyze(*Masker).Mask(*Miner).Clusters(*Miner).TrainExport coverage additions:
pkg/workflowAWFBoundedQueriesConfig,BoundedQueriesConfig,BoundedQueryRuntime*GitHubMCPDefaultFields,GitHubMCPFeatureFieldsParamBuildEngineSecretValidationStep,HasBashExplicitRestriction(*EngineRegistry).EnginesWithCapability,(*RepoConfig).IsActionFailureIssueExpiresExplicitExport coverage additions:
pkg/cliAuditData,AuditDiff,CrossRunAuditReport,UpgradeConfig,WorkflowTrialResultGrantImage,GrypeImage,ShellcheckImage,SyftImage,YamllintImage)RemoveTopLevelFieldFromFrontmatter,RunActionlintOnFiles,RunAddInteractive,MergeWorkflowContent